home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 24 / AACD 24.iso / AACD / Online / Epic4 / share / epic / help / 6_functions / encode < prev    next >
Text File  |  2001-03-21  |  1KB  |  35 lines
  1. Synopsis:
  2.    $encode(<text>)
  3.    $decode(<text>)
  4.  
  5. Technical:
  6.    Given any input, $encode() will return a unique string that can serve as
  7.    an lvalue (a variable name that can be ASSIGNed to.)  Use $decode() to
  8.    retrieve the original text.  The $encode() function is case-preserving.
  9.  
  10. Practical:
  11.    The $encode() function is used to convert an arbitrary text string into
  12.    a string suitable for use in variable or alias names.  This might be
  13.    used to set up a hash table keyed with nick!user@host patterns.  The
  14.    $decode() function does just the opposite, converting a string returned
  15.    by $encode() to the original string.
  16.  
  17. Returns:
  18.    encode: encoded string
  19.    decode: decoded string
  20.  
  21. Examples:
  22.    $encode(hello there)               returns "GIGFGMGMGPCAHEGIGFHCGF"
  23.    $decode(GIGFGMGMGPCAHEGIGFHCGF)    returns "hello there"
  24.    $decode($encode(hello there))      returns "hello there"
  25.  
  26. See Also:
  27.    assign(5)
  28.  
  29. Other Notes:
  30.    You should not trust $encode() to return any specific string.  You may
  31.    only trust that it is unique given the input string, and that you may
  32.    use the return value as an lvalue.  Any other use of $encode() should be
  33.    considered an error.
  34.  
  35.